ekzyis
/
stacker.news
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,307 Commits 4 Branches 0 Tags 75 MiB
JavaScript 74.2%
PLpgSQL 21.5%
CSS 1.7%
SCSS 1.2%
Shell 1.1%
Other 0.3%
Go to file
ekzyis dde82e25a5
Convert worker to ESM (#500) 
* Convert worker to ESM

To use ESM for the worker, I created a package.json file in worker/ with `{ type: "module" }` as its sole content.

I then rewrote every import to use ESM syntax.

I also tried to set `{ type: "module" }` in the root package.json file to also use ESM in next.config.js.

However, this resulted in a weird problem: default imports were now getting imported as objects in this shape: `{ default: <defaultImport> }`.

Afaik, this should only be the case if you use "import * as foo from 'bar'" syntax: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#default_import

This is fixed by not using `{ type: "module" }` for some reason. However, then, next.config.js also doesn't support ESM import syntax anymore.

The documentation says that if you want to use ESM, you can use next.config.mjs: https://nextjs.org/docs/pages/api-reference/next-config-js

But I didn't want to use MJS extension since I don't have any experience with it. For example, not sure if it's good style to mix JS with MJS etc. So I kept the CJS import syntax there.

* Ignore worker/ during linting

I wasn't able to fix the following errors:

/home/runner/work/stacker.news/stacker.news/worker/auction.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/auction.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/earn.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/earn.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/index.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/index.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/nostr.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/nostr.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/ots.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/ots.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/repin.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/repin.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/search.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/search.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/streak.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/streak.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/trust.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/trust.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/views.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/views.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)
/home/runner/work/stacker.news/stacker.news/worker/wallet.js:0:0: Parsing error: No Babel config file detected for /home/runner/work/stacker.news/stacker.news/worker/wallet.js. Either disable config file checking with requireConfigFile: false, or configure Babel so that it can find the config files. (null)

I tried to tell babel where to find the babel config file (.babelrc), specifying the babel config in worker/package.json under "babel", using babel.config.json etc. to no avail.

However, afaict, we don't need babel for the worker since it won't run in a browser. Babel is only used to transpile code to target browsers.

But it still would be nice to lint the worker code with standard.

But we can figure this out later.

* Fix worker imports from lib/ and api/

This fixes the issue that we can't use `{ "type": "module" }` in the root package.json since it breaks the app with this error:

  app  | TypeError: next_auth_providers_credentials__WEBPACK_IMPORTED_MODULE_2__ is not a function
  app  |     at eval (webpack-internal:///./pages/api/auth/[...nextauth].js:218:20)
  app  |     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
  app  | LND GRPC connection successful
  app  | - error pages/api/auth/[...nextauth].js (139:2) @ CredentialsProvider
  app  | - error Error [TypeError]: next_auth_providers_credentials__WEBPACK_IMPORTED_MODULE_2__ is not a function
  app  |     at eval (webpack-internal:///./pages/api/auth/[...nextauth].js:218:20) {
  app  |   digest: undefined
  app  | }
  app  |   137 |
  app  |   138 | const providers = [
  app  | > 139 |   CredentialsProvider({
  app  |       |  ^
  app  |   140 |     id: 'lightning',
  app  |   141 |     name: 'Lightning',
  app  |   142 |     credentials: {
  app  | TypeError: next_auth_providers_credentials__WEBPACK_IMPORTED_MODULE_2__ is not a function
  app  |     at eval (webpack-internal:///./pages/api/auth/[...nextauth].js:218:20)
  app  |     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

build but we need to tell the worker that the files are MJS, else we get this error:

  worker  | file:///app/worker/wallet.js:3
  worker  | import { datePivot } from '../lib/time.js'
  worker  |          ^^^^^^^^^
  worker  | SyntaxError: Named export 'datePivot' not found. The requested module '../lib/time.js' is a CommonJS module, which may not support all module.exports as named exports.
  worker  | CommonJS modules can always be imported via the default export, for example using:
  worker  |
  worker  | import pkg from '../lib/time.js';
  worker  | const { datePivot } = pkg;
  worker  |
  worker  |     at ModuleJob._instantiate (node:internal/modules/esm/module_job:124:21)
  worker  |     at async ModuleJob.run (node:internal/modules/esm/module_job:190:5)
  worker  |
  worker  | Node.js v18.17.0
  worker  |
  worker exited with code 1

* Fix global not defined in browser context

* Also ignore api/ and lib/ during linting

I did not want to do this but I was not able to fix this error in any other way I tried:

  /home/ekzyis/programming/stacker.news/api/lnd/index.js:0:0: Parsing error: No Babel config file detected for /home/ekzyis/programming/stacker.news/api/lnd/index.js. Either disable config file checking with requ
ireConfigFile: false, or configure Babel so that it can find the config files. (null)

Did not want to look deeper into all this standard, eslint, babel configuration stuff ...

---------

Co-authored-by: ekzyis <ek@stacker.news>
Co-authored-by: Keyan <34140557+huumn@users.noreply.github.com>
 		2023-09-23 20:19:35 -05:00
.ebextensions add lb based scaling health check 2023-08-02 21:33:53 -05:00
.github Eslint setup and github action (#360) 2023-08-07 18:43:15 -05:00
.platform Remove Content-Length header for requests to /api/lnauth (#413) 2023-08-15 12:52:56 -05:00
.vscode remove vscode settings 2022-06-08 16:56:35 -05:00
api Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00
components Implementing LUD-12 comments on payRequest in LNURLP Lightning Address flow (sending and receiving) (#498) 2023-09-23 20:14:49 -05:00
docs Add docs for local LND setup 2023-05-19 18:28:46 -05:00
fragments Implementing LUD-12 comments on payRequest in LNURLP Lightning Address flow (sending and receiving) (#498) 2023-09-23 20:14:49 -05:00
lib Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00
pages Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00
prisma Implementing LUD-12 comments on payRequest in LNURLP Lightning Address flow (sending and receiving) (#498) 2023-09-23 20:14:49 -05:00
public Make the web manifest dynamic to incorporate preferred color scheme (#398) 2023-08-15 12:58:27 -05:00
scripts newsletter template improvements 2023-09-03 11:59:55 -05:00
spawn upgrade deps 2022-11-06 11:28:58 -06:00
styles prevent wallet balance overflow 2023-09-12 20:21:59 -05:00
svgs use code icon for contibutors 2023-09-18 14:17:22 -05:00
sw Add setting to send diagnostics back to SN (#463) 2023-09-18 18:00:16 -05:00
worker Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00
.babelrc dark mode with css variables instead 2021-11-09 16:43:56 -06:00
.env.sample Add setting to send diagnostics back to SN (#463) 2023-09-18 18:00:16 -05:00
.gitignore remove slashtags completely 2023-08-17 13:40:21 -05:00
.npmrc Revert "Revert "shield your eyes; massive, squashed refactor; nextjs/react/react-dom/apollo upgrades"" 2023-07-23 10:08:43 -05:00
.puppeteerrc.cjs puppeteer config 2022-11-16 10:57:03 -06:00
Dockerfile use node v18 in docker 2023-08-07 13:19:11 -05:00
LICENSE add license 2021-06-28 18:28:26 -05:00
Procfile remove check from procfile 2022-01-09 11:57:15 -06:00
README.md Update README.md 2023-08-19 16:12:18 -05:00
contributors.txt add a few contributors 2023-09-18 14:20:19 -05:00
docker-compose.yml Render images without markdown and use image proxy (#245) 2023-07-12 19:10:01 -05:00
middleware.js referrals 2022-12-19 16:27:52 -06:00
next.config.js Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00
package-lock.json Add setting to send diagnostics back to SN (#463) 2023-09-18 18:00:16 -05:00
package.json Convert worker to ESM (#500) 2023-09-23 20:19:35 -05:00

README.md

contributing

We pay sats for PRs. Sats will be proportional to the impact of the PR. If there's something you'd like to work on, suggest how much you'd do it for on the issue. If there's something you'd like to work on that isn't already an issue, whether its a bug fix or a new feature, create one.

We aim to have a quick pr turnaround time, but we are sometimes slower than we'd like. In most cases, if your pr is unambiguously good, it shouldn't take us more than 1 week.

If you have a question about contributing start a discussion.

responsible disclosure

If you found a vulnerability, we would greatly appreciate it if you contact us via kk@stacker.news or t.me/k00bideh.

stacker.news

Stacker News is like Hacker News but we pay you Bitcoin. We use Bitcoin and the Lightning Network to provide Sybil resistance and any karma earned is withdrawable as Bitcoin.

wen decentralization

We're experimenting with providing an SN-like service on nostr in Outer Space. It's our overarching goal to align SN with Bitcoin's ethos yet still make a product the average bitcoiner loves to use.

local development

  1. Install docker-compose and deps if you don't already have it installed
  2. git clone git@github.com:stackernews/stacker.news.git sn && cd sn
  3. docker-compose up --build

You should then be able to access the site at localhost:3000 and any changes you make will hot reload. If you want to login locally or use lnd you'll need to modify .env.sample appropriately. More details here and here. If you have trouble please open an issue so I can help and update the README for everyone else.

web push

To enable Web Push locally, you will need to set the VAPID_* env vars. VAPID_MAILTO needs to be a email address using the mailto: scheme. For NEXT_PUBLIC_VAPID_KEY and VAPID_PRIVKEY, you can run npx web-push generate-vapid-keys.

imgproxy

To configure the image proxy, you will need to set the IMGPROXY_ env vars. NEXT_PUBLIC_IMGPROXY_URL needs to point to the image proxy service. IMGPROXY_KEY and IMGPROXY_SALT can be set using openssl rand -hex 64.

stack

The site is written in javascript using Next.js, a React framework. The backend API is provided via graphql. The database is postgresql modelled with prisma. The job queue is also maintained in postgresql. We use lnd for our lightning node. A customized Bootstrap theme is used for styling.

processes

There are two. 1. the web app and 2. the worker, which dequeues jobs sent to it by the web app, e.g. polling lnd for invoice/payment status

wallet transaction safety

To ensure stackers balances are kept sane, all wallet updates are run in serializable transactions at the database level. Because prisma has relatively poor support for transactions all wallet touching code is written in plpgsql stored procedures and can be found in the prisma/migrations folder.

code

The code is linted with standardjs.

license

MIT