Push Notifications Package #2081

adamfraser · 2024-08-13T18:34:10Z

Changelist

Add a new package to enable sending push notifications via Firebase

Test Plan

[Describe how this PR was tested (if applicable)]

linear · 2024-08-13T18:34:13Z

CT-1040 Indexer Push Notifications

coderabbitai · 2024-08-13T18:34:15Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

This reverts commit b753be5.

dydxwill · 2024-08-22T23:20:12Z

indexer/packages/notifications/src/config.ts

+  FIREBASE_PRIVATE_KEY_BASE64: parseString({ default: 'LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tClBMQUNFSE9MREVSX0tFWV9GT1JfREVWRUxPUE1FTlQKLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLQo=' }),
+
+  // APP ID for the Google Firebase Messaging project
+  FIREBASE_PROJECT_ID: parseString({ default: 'dydx-v4' }),


does eng need access to this (eventually)?

dydxwill · 2024-08-22T23:20:42Z

indexer/packages/notifications/src/lib/firebase.ts

+const initializeFirebaseApp = () => {
+  const defaultGoogleApplicationCredentials: { [key: string]: string } = {
+    project_id: config.FIREBASE_PROJECT_ID,
+    private_key: Buffer.from(config.FIREBASE_PRIVATE_KEY_BASE64, 'base64').toString('ascii').replace(/\\n/g, '\n'),


comment for what this is doing/why needed

dydxwill · 2024-08-22T23:28:59Z

indexer/packages/notifications/src/lib/firebase.ts

+    message: 'Initializing Firebase App',
+  });
+
+  const serviceAccount: ServiceAccount = defaultGoogleApplicationCredentials;


why do we need this line? combine with l13?

dydxwill · 2024-08-22T23:30:49Z

indexer/packages/notifications/src/lib/firebase.ts

+
+import config from '../config';
+
+const initializeFirebaseApp = () => {


existing syntax for functions is function initializeFirebaseApp(): void {

dydxwill · 2024-08-22T23:32:52Z

indexer/packages/notifications/src/localizedMessages.ts

+/* eslint-disable no-template-curly-in-string */
+import { LocalizationKey, LanguageCode } from './types';
+
+export const LOCALIZED_MESSAGES: Record<LanguageCode, Record<LocalizationKey, string>> = {


existing convention is separate with dashes, e.g. localized-messages.ts

dydxwill · 2024-08-22T23:34:03Z

indexer/packages/notifications/src/types.ts

@@ -0,0 +1,152 @@
+export enum NotificationType {


include enum description to be consistent

dydxwill · 2024-08-22T23:35:32Z

indexer/packages/notifications/src/types.ts

+
+export function createNotification<T extends NotificationType>(
+  type: T,
+  dynamicValues: T extends NotificationType.DEPOSIT_SUCCESS


this typing seems really complicated, anyway to simplify?

dydxwill · 2024-08-22T23:36:35Z

indexer/packages/postgres/src/stores/token-table.ts

@@ -0,0 +1,132 @@
+import { DateTime } from 'luxon';


token-table is a little vague. Can we be a bit more specific? perhaps firebase-notification-token-table?

dydxwill · 2024-08-22T23:36:48Z

indexer/packages/postgres/src/models/token-model.ts

+import { IsoString } from '../types';
+import WalletModel from './wallet-model';
+
+class TokenModel extends Model {


comment for what this is used for

dydxwill · 2024-08-22T23:37:12Z

indexer/packages/postgres/src/types/token-types.ts

+
+type IsoString = string;
+
+export interface TokenCreateObject {


Token -> FirebaseNotificationToken ?

adamfraser added 6 commits August 7, 2024 17:03

Add notifications package

a72f374

Add firebase-admin dependency

fd9010d

Add register token endpoint

09440d3

Add Tokens table

8558d45

Register token with postgres from comlink

ce9ce9a

Can create and send notifications

f813892

github-actions bot added the indexer label Aug 13, 2024

adamfraser force-pushed the adam/ct-1040-indexer-push-notifications branch from e0b43d5 to 9e659fd Compare August 13, 2024 18:57

adamfraser temporarily deployed to dev4 August 13, 2024 18:57 — with GitHub Actions Inactive

adamfraser temporarily deployed to dev4 August 13, 2024 19:15 — with GitHub Actions Inactive

adamfraser temporarily deployed to dev4 August 13, 2024 19:23 — with GitHub Actions Inactive

adamfraser force-pushed the adam/ct-1040-indexer-push-notifications branch from 8196063 to a11b478 Compare August 21, 2024 15:32

adamfraser temporarily deployed to dev4 August 21, 2024 15:32 — with GitHub Actions Inactive

adamfraser added 2 commits August 21, 2024 13:08

Refactor

6243d74

Add localization strings

ccb1f77

adamfraser force-pushed the adam/ct-1040-indexer-push-notifications branch from a11b478 to ccb1f77 Compare August 21, 2024 17:33

adamfraser temporarily deployed to dev4 August 21, 2024 17:33 — with GitHub Actions Inactive

Add language to Token table

48b1be9

adamfraser temporarily deployed to dev4 August 22, 2024 20:04 — with GitHub Actions Inactive

Revert "Wip deploy to dev4"

00c396f

This reverts commit b753be5.

dydxwill reviewed Aug 22, 2024

View reviewed changes

adamfraser closed this Sep 17, 2024

adamfraser deleted the adam/ct-1040-indexer-push-notifications branch September 17, 2024 15:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Push Notifications Package #2081

Push Notifications Package #2081

adamfraser commented Aug 13, 2024

linear bot commented Aug 13, 2024

coderabbitai bot commented Aug 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024

dydxwill Aug 22, 2024


		import config from '../config';

		const initializeFirebaseApp = () => {


		type IsoString = string;

		export interface TokenCreateObject {

Push Notifications Package #2081

Push Notifications Package #2081

Conversation

adamfraser commented Aug 13, 2024

Changelist

Test Plan

linear bot commented Aug 13, 2024

coderabbitai bot commented Aug 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)