linting and PR comment changes

Author: c298lee

packages/feedback/.eslintignore

@@ -1,6 +1,2 @@
 node_modules/
 build/
-demo/build/
-# TODO: Check if we can re-introduce linting in demo
-demo
-metrics

packages/feedback/.eslintrc.js

@@ -6,12 +6,6 @@
 module.exports = {
   extends: ['../../.eslintrc.js'],
   overrides: [
-    {
-      files: ['src/**/*.ts'],
-      rules: {
-        '@sentry-internal/sdk/no-unsupported-es6-methods': 'off',
-      },
-    },
     {
       files: ['jest.setup.ts', 'jest.config.ts'],
       parserOptions: {

packages/feedback/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-Copyright (c) 2022 Sentry (https://sentry.io) and individual contributors. All rights reserved.
+Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation the

packages/feedback/LICENSE

@@ -10,6 +10,9 @@
 [![npm dm](https://img.shields.io/npm/dm/@sentry/feedback.svg)](https://www.npmjs.com/package/@sentry/feedback)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/feedback.svg)](https://www.npmjs.com/package/@sentry/feedback)
 
+This SDK is **considered experimental and in an alpha state**. It may experience breaking changes, and may be discontinued at any time. Please reach out on
+[GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns.
+
 ## Pre-requisites
 
 `@sentry/feedback` requires Node 12+, and browsers newer than IE11.

packages/feedback/MIGRATION.md

@@ -4,8 +4,8 @@ const baseBundleConfig = makeBaseBundleConfig({
   bundleType: 'addon',
   entrypoints: ['src/index.ts'],
   jsVersion: 'es6',
-  licenseTitle: '@sentry/replay',
-  outputFileBase: () => 'bundles/replay',
+  licenseTitle: '@sentry-internal/feedback',
+  outputFileBase: () => 'bundles/feedback',
 });
 
 const builds = makeBundleConfigVariants(baseBundleConfig);

packages/feedback/README.md

@@ -7,7 +7,7 @@ export default makeNPMConfigVariants(
       output: {
         // set exports to 'named' or 'auto' so that rollup doesn't warn
         exports: 'named',
-        // set preserveModules to false because for Replay we actually want
+        // set preserveModules to false because for feedback we actually want
         // to bundle everything into one file.
         preserveModules: false,
       },

packages/feedback/rollup.bundle.config.js

@@ -1 +1,2 @@
-export type { SendFeedbackData } from './types'
+export type { SendFeedbackData } from './types';
+export { sendFeedbackRequest } from './util/sendFeedbackRequest';

packages/feedback/rollup.npm.config.js

@@ -1,4 +1,4 @@
-import type {Event} from '@sentry/types';
+import type { Event, Primitive } from '@sentry/types';
 
 /**
  * NOTE: These types are still considered Beta and subject to change.
@@ -16,8 +16,12 @@ export interface FeedbackEvent extends Event {
 }
 
 export interface SendFeedbackData {
-  message: string,
-  email: string,
-  replay_id: string,
-  url: string,
+  feedback: {
+    message: string;
+    email: string;
+    replay_id: string | undefined;
+    name: string;
+    url: string;
+  };
+  tags: { [key: string]: Primitive } | undefined;
 }

packages/feedback/src/index.ts

@@ -1,5 +1,5 @@
-import type {Scope} from '@sentry/core';
-import {prepareEvent} from '@sentry/core';
+import type { Scope } from '@sentry/core';
+import { prepareEvent } from '@sentry/core';
 import type { Client } from '@sentry/types';
 
 import type { FeedbackEvent } from '../types';
@@ -16,11 +16,16 @@ export async function prepareFeedbackEvent({
   event: FeedbackEvent;
   scope: Scope;
 }): Promise<FeedbackEvent | null> {
+  const eventHint = { integrations: undefined };
+  if (client.emit) {
+    client.emit('preprocessEvent', event, eventHint);
+  }
+
   const preparedEvent = (await prepareEvent(
     client.getOptions(),
     event,
-    {integrations: []},
-    scope
+    { integrations: undefined },
+    scope,
   )) as FeedbackEvent | null;
 
   // If e.g. a global event processor returned null
@@ -35,7 +40,7 @@ export async function prepareFeedbackEvent({
 
   // extract the SDK name because `client._prepareEvent` doesn't add it to the event
   const metadata = client.getSdkMetadata && client.getSdkMetadata();
-  const {name, version} = (metadata && metadata.sdk) || {};
+  const { name, version } = (metadata && metadata.sdk) || {};
 
   preparedEvent.sdk = {
     ...preparedEvent.sdk,

packages/feedback/src/types/feedback.ts

@@ -8,10 +8,8 @@ import { prepareFeedbackEvent } from './prepareFeedbackEvent';
  * Send feedback using `fetch()`
  */
 export async function sendFeedbackRequest({
-  message,
-  email,
-  replay_id,
-  url,
+  feedback: { message, email, name, replay_id, url },
+  tags,
 }: SendFeedbackData): Promise<Response | null> {
   const hub = getCurrentHub();
 

packages/feedback/src/util/prepareFeedbackEvent.ts

@@ -1,6 +1,2 @@
 node_modules/
 build/
-demo/build/
-# TODO: Check if we can re-introduce linting in demo
-demo
-metrics

packages/feedback/src/util/sendFeedbackRequest.ts

@@ -1,4 +1,4 @@
-import type {Event} from './event';
+import type { Event } from './event';
 
 /**
  * NOTE: These types are still considered Beta and subject to change.