Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sweep: Adding detailed description to issues #1

Open
wwzeng1 opened this issue Jul 26, 2023 · 1 comment · May be fixed by #3
Open

Sweep: Adding detailed description to issues #1

wwzeng1 opened this issue Jul 26, 2023 · 1 comment · May be fixed by #3
Labels
sweep Assigns Sweep to an issue or pull request.

Comments

@wwzeng1
Copy link

wwzeng1 commented Jul 26, 2023

We need to add more details and context when raising issue. This will improve and foster contributions.

@sweep-ai sweep-ai bot added the sweep Assigns Sweep to an issue or pull request. label Jul 26, 2023
@sweep-ai
Copy link

sweep-ai bot commented Jul 26, 2023

Here's the PR! #3.

💎 Sweep Pro: I used GPT-4 to create this ticket. You have 4 GPT-4 tickets left.


Step 1: 🔍 Code Search

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description.

convoy/CONTRIBUTING.md

Lines 1 to 47 in 15444ec

# How to contribute
We definitely welcome your patches and contributions to convoy!
If you are new to github, please start by
reading [Pull Request howto](https://help.github.com/articles/about-pull-requests/)
## Guidelines for Pull Requests
How to get your contributions merged smoothly and quickly.
- Create **small PRs** that are narrowly focused on **addressing a single concern**. We often times receive PRs that are
trying to fix several things at a time, but only one fix is considered acceptable, nothing gets merged and both
author's & review's time is wasted. Create more PRs to address different concerns and everyone will be happy.
- The convoy package should only depend on standard Go packages and a small number of exceptions. If your contribution
introduces new dependencies which are NOT in the [list](https://pkg.go.dev/github.com/frain-dev/convoy?tab=imports),
you need a discussion with the convoy creators.
- For speculative changes, consider opening an issue and discussing it first. If you are suggesting a behavioral or API
change, consider starting with a proposal draft.
- Provide a good **PR description** as a record of **what** change is being made and **why** it was made. Link to a
github issue if it exists.
- Don't fix code style and formatting unless you are already changing that line to address an issue. PRs with irrelevant
changes won't be merged. If you do want to fix formatting or style, do that in a separate PR.
- Unless your PR is trivial, you should expect there will be reviewer comments that you'll need to address before
merging. We expect you to be reasonably responsive to those comments, otherwise the PR will be closed after 2-3 weeks
of inactivity.
- Maintain **clean commit history** and use **meaningful commit messages**. PRs with messy commit history are difficult
to review and won't be merged. Use
`rebase -i upstream/main` to curate your commit history and/or to bring in latest changes from main (but avoid
rebasing in the middle of a code review).
- Keep your PR up to date with upstream/main (if there are merge conflicts, we can't really merge your change).
- **All tests need to be passing** before your change can be merged. We recommend you **run tests locally** before
creating your PR to catch breakages early on.
- `make all` to test everything, OR
- `make vet` to catch vet errors
- `make test` to run the tests
- `make testrace` to run tests in race mode
- For convenience, run `make setup` to run set relevant configurations, like a pre-commit hook to regenerate openapi docs on every commit to files in the server folder.

convoy/CHANGELOG.md

Lines 1 to 452 in 15444ec

## 23.06.3
- [Feature] Add support for Webhooks Idempotency #1651 #1688
- [Enhancement] Add support for deleting archived tasks #1657
- [Enhancement] Improved list projects view #1669 #1678 #1683
- [Enhancement] Remove 50Kb limit on MaxResponseSize config #1675
- [Enhancement] Create Fanout Event if Owner ID is tied to a portal link #1682
- [Bugfix] Delete duplicate task ID when writing to queue #1660
- [Bugfix] Fixed view endpoint under portal link's event delivery page #1666
- [Bugfix] Fixed issue with closing google pub/sub client #1673
- [Bugfix] Fixed issue with overriding config with cli flags #1668
- [Bugfix] Fixed issue with HTTP timeout validation #1680
## 23.06.2
- [Enhancement] Improved logging to include response body #1655
- [Enhancement] Improved Datetime filtering UX #1644
- [Bugfix] Fixed update project settings while switching tabs bug #1653
- [Bugfix] Fixed default retention policy #1652
- [Bugfix] Fix multi-tenancy issue on portal links with ownerID. #1654
## 23.06.1
- [Feature] Add custom response to incoming project sources #1605
- [Feature] Enabled endpoint management on portal links #1616
- [Feature] Support ingest query parameters to incoming sources #1640
- [Enhancement] Improved New Relic Integration #1621
- [Enhancement] Enabled auto API docs syncing #1625
- [Enhancement] Add endpoint timeout config option to the dashboard #1614
- [Enhancement] Improved portal page responsiveness #1648
- [Enhancement] Improved request and response annotations #1608 #1619 #1627 #1622 #1630 #1611 #1636 #1632 #1637 #1631 #1641
- [Bugfix] Fixed FindSubscriptionByDeviceID query bug #1647
- [Bugfix] Coalesce url query parameters #1642
- [Bugfix] Fixed event delivery filtering by status #1626
- [Bugfix] Fixed index on organisations invite index #1603 #1607
- [Bugfix] Link ownerID to portal links without endpoints #1638
## 23.05.5
- [Enhancement] Optimise Migration Queries #1601
## 23.05.4
- [Bugfix] Return error when persisting to redis fails on the ingest route #1597
## 23.05.3
- [Enhancement] Postgres and Redis config options will now be supplied in parts to allow for fine-grained configuration #1579
- [Bugfix] Fixed an issue where the email verification flow could not be completed #1586
- [Bugfix] Fixed an issue where the frontend client sent the wrong pagination cursor value #1588
- [Bugfix] Fixed an issue where a project could not be saved due to meta-event form valiation #1589
- [Bugfix] Fixed an issue where the source id query param was not being used to filter when fetching events #1587
## 23.05.2
- [Feature] Added support for meta events #1541
- [Bugfix] Fixed multi-tenancy bug with portal links #1582
- [Bugfix] Fixed issue with new user with no organisation #1578
## 23.05.1
- [Feature] Add support for on the fly events #1558
- [Enhancement] Add prompt for disabling endpoints #1556
- [Enhancement] Extend subscription filter capabilities #1545 #1566
- [Enhancement] Improved logging for all workers #1560
## 0.9.2
- [Documentation] Fix noun/verb agreement #1504
- [Enhancement] Add support for pausing an endpoint #1529 #1527
- [Bugfix] Fixed a bug where an endpoint would be stuck in pending #1529
- [Bugfix] Fixed max response size log on server startup #1507
- [Bugfix] Add endpoint metadata to event search results #1508
- [Bugfix] Fixed an issue where the reset password flow could not be completed #1506 #1503
## 0.9.1
- [Enhancement] Add default db connection options #1496
- [Enhancement] Move check for hiding pagination to entire container #1497
- [Enhancement] Add support for filtering by "owner_id" when fetching endpoints and by an array of endpoints when fetching subscriptions #1498
- [Enhancement] Add signup enabled environment variable #1495
- [Bugfix] Change TrimSuffix to TrimSpace when fetching convoy version #1501
- [Bugfix] Redirect to the "get started" page when there's no orgnaization for that user #1500
## 0.9.0
- [Documentation] Update API Annotations #1478
- [Enhancement] Change font to inter #1470
- [Enhancement] QoL Postgres Updates #1419
- [Enhancement] Port Stream Server #1482
- [Enhancement] UI updates #1491 #1490 #1486 #1474 #1480
- [Bugfix] Check pending migrations #1487
- [Bugfix] fix message payload for process event delivery #1483
## 0.9.0-rc.3
- [Bugfix] Fix search indexer job #1448 #1449
- [Bugfix] Fix refresh token issue #1447
- [Bugfix] Fix event graph length #1443
## 0.9.0-rc.2
- [Bugfix] Fix issue with updating PubSub Sources #1440
- [Enhancement] Fix toggle and view subscription. #1424
- [Enhancement] Create room for empty data on chart. #1422 #1425
## 0.9.0-rc.1
- [Feature] Add new message broker source. #1285
- [Enhancement] Switched backing store to PostgreSQL. #1287
- [Enhancement] Add modal to confirm before regenerating API Keys. #1378
- [Enhancement] Implement new wait screens #1398
## 0.8.3
- [Bugfix] Fix search indexer job #1448 #1449
## 0.8.2
- [Feature] Set Advanced Signatures by default for Incoming projects.
- [Enhancement] Refactored Convoy CLI Implementation. #1290
- [Enhancement] Improved Project Onboarding #1335
- [Enhancement] Improved Delivery Attempt Details page #1341
- [Enhancement] Update Subscriptions Card for Incoming Projects. #1349
- [Enhancement] Update portal links design #1348
- [Enhancement] Improve source, subscription and endpoint forms #1335
- [Bugfix] Event Log pagination bug #1346
- [Bugfix] Date picker bug fix #1355
## 0.8.1
- [Enhancement] Improved stats query #1256
- [Enhancement] Add analytics and storage policy settings in convoy.josn #1284 #1324
- [Feature] Set notifications by default #1251
- [Feature] Add raw invite link in invite email #1279
- [Feature] Allow user re-generate api key for projects #1277
## 0.8.0
- [Feature] Filter by HTTP Headers #1240 #1232 #1249
- [Feature] Add force retry and batch retry to event logs #1237
- [Feature] Add convoy version to private pages #1230
- [Feature] Add frontend analytics and welcome email #1209
- [Feature] Build source-maps to separate folder #1216
- [Feature] Change group to project #1207
- [Feature] Filter events using event types and subscriptions #1205 #1217
- [Feature] Add custom domain support #1203
- [Feature] use central logger everywhere #1176
- [Feature] Deprecate Apps in favor of Endpoints #1169 #1159 #1069 #1158
- [Feature] Deprecate `document_status` in favor of `delete_at` #1123 #1168
- [Feature] Filter events by the subcription filtering #1096 #1116
- [Feature] Added support for http connect proxy #1146
- [Enhancement] Deprecate subscription status field #1243 #1234
- [Enhancement] Update email verification flow #1227
- [Enhancement] Improved onboarding forms #1245 #1244 #1246
- [Enhancement] MaxIngestSize can be configured per group/project #1160
- [Enhancement] Use mongo aggregations when quering multuple collections #1611 #1153
- [Enhancement] Redirect user to previous page on login after session timeout #1154
- [Enhancement] Add response body to endpoint disabled notification email/slack message #1141 #1152
- [Enhancement] Email verification check after signup #1208 #1186
- [Enhancement] Add support for building alpine images #1108
- [Enhancement] Add api key migrations #1166
- [Bugfix] Add raw value to event payload #1236
- [Bugfix] Persist advanced signatures config #1233
- [Bugfix] Fix migration tool #1226
- [Bugfix] Token modal on project creation now show visual feedback #1242
- [Bugfix] Show event deliveries in correct order #1202 #1157
- [Bugfix] Used correct type for rate limit duation #1201
- [Bugfix] Fixed events in discarded state getting stuck #1200
- [Bugfix] Fixed events should be created regardless of subscriptions logic
- [Bugfix] Enable default retention policy duration #1163
- [Bugfix] fixed hobby deployment installation script #1139 #1136 #1135 #1134
- [Bugfix] Update navbar on creating project on new organisation #1250
- [Bugfix] Update validation check for create project form #1248
## 0.7.6
- [Bugfix] Preserve whitespaces in event payload #1223
## 0.7.5
- [Enhancement] Filter event deliveries by subscriptions #1192
- [Bugfix] fix prism import error #1194
- [Bugfix] correctly use query string in app portal #1195
## 0.7.4
- [Enhancement] hide cli keys and devices on app portal #1184
- [Bugfix] pass query params along in shim #1185
## 0.7.3
- [Enhancement] Set app portal key expiration to 30 days #1170 #1171
## 0.7.2
- [Bugfix] Fix Max response size CLI override #1098
- [Feature] Advanced Signatures Core Implementation #1053 #1100 #1103 #1104
- [Feature] Refactored Logging Implementation #1051
- [Bugfix] Update endpoint with custom authentication #1119 #1106 #1107 #1105
- [Enhancement] Add support for building alpine image #1108
## 0.7.1
- [Bugfix] Fix Max response size CLI override #1098
## 0.7.0
- [Feature] Add support for feature flags #1054
- [Enhancement] Enable source filter on Events dashboard #1058 #1043
- [Bugfix] Use configured max request size in ingest handler #1086
- [Feature] Use mongo aggregation pipeline to fetch subscriptions #1073
- [Feature] Run Convoy in Headless mode #1034
- [Enhancement] New UI Onboarding #1048
- [Bugfix] Fixed retention policies task handler #1049
- [Bugfix] Set default body for ingested events to empty JSON #1062
- [Feature] Add support for endpoint authentication #1045
- [Bugfix] The change stream should not be killed when an error occurs in the handler #1061
- [Enhancement] Fix build warnings #1089
- [Bugfix] Several UI fixes #1087
## 0.7.0-rc.2
- [Feature] Create cli api keys and manage devices from the app portal #983
- [Bugfix] Fix Subscription Config Inheritance For Event Deliveries #995
- [Enhancement] Implement cascading delete for groups, apps and sources #1037
- [Enhancement] Add help to project sidebar #1032
## 0.7.0-rc.1
- [Feature] Add a command to run convoy migrations #989 #996 #993
- [Feature] Storybook setup #927
- [Feature] Add load test scripts #997
- [Feature] Add convoy websocket cli event streaming server and client #931
- [Feature] Add support for custom headers for outgoing events #1012
- [Bugfix] Use typesense multi search #994
- [Bugfix] Fix retention policy export #998
- [Bugfix] Allow discarded events to be retried #1016
- [Bugfix] Validate source providers separately #1024
- [Enhancement] Fixed API spec annotations #1005
- [Enhancement] Refactor Store Dependency #1006
## 0.6.8
- [Bugfix] Fix subscriptions page error #1026
- [Bugfix] Add deleted_at to MongoDB indexes #1027
- [Bugfix] Dismiss modal when a source is deleted #1026
## 0.6.7
- [Bugfix] Fix analytics query #1001
- [Bugfix] Fix middleware layer for app portal #988
- [Bugfix] Fix endpoint notification email bug #981
## 0.6.6
- [Bugfix] Fix project statistics lookup query #978 #979
## v0.6.5
- [Feature] Add support for user registration. #959
- [Bugfix] Updated event dashboard with application and source metadata. #960
- [Bugfix] Allow re-invitation of a previously cancelled invitation. #967
- [Enhancement] Projects scoped indexing and search. #945
- [Enhancement] Improved notification system. #954
## v0.6.4
- [Bugfix] Fixed a bug where event deliveries could not be force retried #938
- [Bugfix] Changed the group/project rate limit duration type from string to int #938
- [Bugfix] Fixed a bug where team invites could not be canceled on the UI #940
- [Enhancement] Add an environment variable for the typesense collection name #939
## v0.6.3
- [Enhancement] change app portal url from `/app-portal` to `/app` #924
- [Enhancement] App portal improvements #918
## v0.6.2
- [Feature] Added Proxy Events without Verification #906
- [Enhancement] Reliably forward Incoming events request headers #895
- [Bugfix] Fixed force retry bug #891 #890
## v0.6.1
- [Bugfix] Fixed API response for force retry endpoint #892, #897
- [Bugfix] Changed create configuration to use a post request #896
## v0.6.0
- [Feature] Add Support for Custom Sources (Twitter, Shopify) #869, #833, #826
- [Feature] Add Support for Retention Policies #839, #879
- [Enhancement] Updated UI Architecture to use Tailwind CSS #816
- [Enhancement] Optimised UI to reduce initial bundle size #879
- [Enhancement] Allow all workers to run in a single cluster #876
- [Enhancement] Add cancelled status on org invite #812
- [Bugfix] Fixed wrong FindMany query in subscriptions.go #858
- [Bugfix] Enabled JWT configuration with env variables #813
## v0.6.0-rc.4
- [Bugfix] Fixed bug in correctly using datastore FindMany method #856
## v0.6.0-rc.3
- [Change] Changed host to instance id in the analytics #821
- [Enhancement] Add support for JWT environment variables #813
- [Bugfix] Fix analytics query #825
- [Bugfix] UI bug fixes #814
## v0.6.0-rc.2
- [Bugfix] Dereference slice when finding source subscriptions #808
- [Bugfix] Use redis client in scheduler #807
- [Bugfix] Fixed an issue where the source type would not be updated when updating a Github source
- [Bugfix] Fixed an issue where the application details would not be loaded when creating a subscription
- [Bugfix] Fixed an issue where an organization created by a user would not show on the top bar to be selected
## v0.6.0-rc.1
- [Change] Introduce organisations to partition different sets of projects.
- [Change] Deprecate file authentication and authorisation. You no longer specify authentication credentials from convoy.json. User and permission details are now persisted to the DB and use jwt for authentication.
- [Change] All users are now super users in the OSS core.
- [Change] Sentry error tracking has been deprecated. Only New relic is supported for error tracking.
- [Change] Revamped UI. The former convoy dashboard was revamped to enable more management of several vital resources - users, projects, applications, endpoints, sources, and subscriptions.
- [Change] require_auth has been deprecated. All endpoints will now require authentication.
- [Feature] Add Github Custom source #792 #791
- [Enhancement] Change base_url config variable to host #754
- [Enhancement] Set default event types when filter config is nil #783
- [Enhancement] Switched background job system to asynq. #711
- [Enhancement] Add toggle subscription status endpoint #784
- [Enhancement] Autogenerated webhook secrets use alphanumeric secrets #751
- [Enhancement] Use asynq for the scheduler. #745
- [Bugfix] Prevent an organisation owner from being deactivated #781
- [Bugfix] Fix events ingestion to create event flow #744
- [Bugfix] Fixed a race condition that could occur when making an application endpoint #790
- [Bugfix] Fixed app portal link. #790
- [Bugfix] Use correct arguments for API key verifier #779
- [Bugfix] Fixed switching between organisations #775
- [Bugfix] Return proper error from SendNotification #764
- [Bugfix] Fixed filters in events and event deliveries #718
- [Bugfix] Fixed loaders in projects page #724
## v0.6.0-rc
- [Enhancement] Optimize group statistics query #677
- [Enhancement] pause retry count for rate limit errors #676
- [Enhancement] Add groupID arg to application datastore methods
- [Feature] Add Typesense search backend #652
- [Enhancement] Added integration tests #647 #655 #656 #661 #643 #638
- [Feature] Add support for storing events for disabled apps #663
- [Enhancement] Integrate disq as a replacement for taskq #667
- [Enhancement] Fix mongodb index model type #671
- [Bugfix] Update endpoints secret #640
- [Bugfix] Prevent duplicate app names #635
- [Feature] Force retry on App portal #633
## v0.5.3
- [Feature] Add update scripts for migrating from v0.4 to v0.5 #611
- [Enhancement] Changed the way events are created #592
- [Documentation] Add GroupId to swagger documentation #617
- [Documentation] Fix build command in README.md #600
- [Documentation] Fix convoy.json.example #603
- [Enhancement] Add unit tests for the service layer #596 #594 #593 #589
- [Enhancement] Increase test coverage in server package #584 #581 #565
- [Enhancement] Add unit and e2e test for dashboard component #580 #612
- [Enhancement] Updated UI on dashboard and app portal #616 #590
- [Enhancement] Improve loaders for dashboard and app portal #614 #616
- [Feature] Add slack notification system #562
- [Feature] Add Force Resend to App Portal API #579
- [Enhancement] Configurable Replay attacks on groups #567
## v0.5.0
- [Feature] Convoy can now be configured with only environment variables and/or cli flags #511 #520
- [Feature] Add rate limit to api and ui endpoints using the group id #486
- [Feature] Add configuration option to set rate limits on application endpoints
- [Feature] Add configuration option to set endpoint timeout duration #550
- [Feature] Add support for disabling an application #527
- [Enhancement] Removes the need for always passing the groupID as a query string while authenticating with an API Key. #535
- [Bugfix] Add the correct event delivery status for matched endpoints #503
- [Feature] Convoy now supports replay attack prevention by providing a timestamp in the signature header #528 #537
- [Feature] Convoy now uses filters for batch retrying event deliveries.
- [Feature] Convoy can now force resend successful event deliveries.
- [Enhancement] Introduced a service layer into the code architecure #532 #547 #555 #552
## 0.4.10
- [Feature] We can now download convoy binaries from package managers #459
- [Enhancement] Add support for embedding convoy version file #454
- [Feature] Expose taskq queue metrics #476
- [Feature] Added support for embedding an App portal in a 3rd pary app #463
## 0.4.0
- [Enhancement] Replace bbolt implementation with badger #417
- [Enhancement] Add compound indexex for events, eventdeliveries and applications #418
## 0.4.0-rc
- [Feature] Added in memory queue using taskq #342
- [Feature] Added in memory database using bolt #390 #388 #347 #348 #343
- [Feature] Native Realm Implementation #349
- [Feature] Add Group statistics #330
- [Feature] Spilt Server Worker CLI #350
- [Feature] Add support for New Relic #264
- [Feature] Add application search #336
- [Bugfix] Configure Max response size to store #345
- [Enhancement] Fix slow dashboard summary endpoint #381
- [Enhancement] Improve Request Validation #365
- [Enhancement] Event deliveries search apps filter #382
## 0.3.0
- [Bugfix] Fixed hash computation bug #269
- [Bugfix] Bundled UI into binary builds. #273
- [Bugfix] Don't enqueue discarded events #253
- [Enhancement] Build Convoy dashboard UI into npm package in `dashboard-component` #272
## 0.3.0-rc
- [Feature] URL/Events: User can specify events to each endpoint.
- [Feature] Batch Retries: User can batch retry multiple event deliveries at once.
- [Feature] Unified auth configuration for both UI and API.
- [Feature] Added minimal rbac for super user, admin and ui admin.
- [Feature] New tab to view event deliveries for events.
- [Feature] Filter event deliveries by delivery status, app and date range
- [Feature] View event deliveries status for each event from event's details section.
- [Feature] Introduced Groups: To support multi-tenancy for multiple products to pipe events as separete groups.
- [Feature] Persist events and event deliveries filters, active group and active logs tab with page reload.
## 0.2.0
- [Feature] Add disable events and send email notifications.
- [Feature] Re-activate endpoints by re-trying a non-successful event.
- [Feature] Enable SMTP configuration.
- [Enhancement] Improved Delivery Attempt Page.
- [Enhancement] Event log filtering by Applications and Date.
- [Enhancement] Changed organisations to groups throughout app.
- [Enhancement] Changed /apps to /applications
- [Enhancement] Create default group on app startup.
- [Enhancement] Clicking events button from apps table now automatically filters events by clicked app.
- [Enhancement] Convoy config details now shows on dashboard.
- [Enhancement] Created at and Next retry on events table now shows time instead of date.
- [Enhancement] Improved table pagination.
- [Enhancement] Events table now grouped by date.
- [Enhancement] Manually retried events now identifiable by a retry icon on events table.
- [Enhancement] Event status now differentiated by status color.

Retry
</button>
</div>
</td>
</tr>
</template>
</tbody>
</table>
<div class="table--load-more button--container center" v-if="eventDeliveries && eventDeliveries.pagination.totalPage > 1">
<button
class="button button__clear button--has-icon icon-left margin-top__20px margin-bottom__24px flex__justify-center"
@click="
eventDeliveriesPage = eventDeliveriesPage + 1;
getEventDeliveries();
"
:disabled="eventDeliveries?.pagination?.page === eventDeliveries?.pagination?.totalPage || isloadingMoreEventDeliveries"
>
<SvgComponent v-show="!isloadingMoreEventDeliveries" :width="'24'" :height="'18'" :id="'angle-arrow-down-big'" />
<SvgComponent v-show="isloadingMoreEventDeliveries" :width="'25'" :height="'24'" :id="'rotate-icon'" :styles="'margin-right__8px'" />
Load more
</button>
</div>
</div>
<div class="empty-state table--container" v-show="(activeTab === 'event deliveries' && !eventDeliveries) || eventDeliveries?.content?.length === 0">
<SvgComponent :width="'130'" :height="'110'" :id="'empty-state'" />
<p>No event to show here</p>
</div>
</div>
<div class="dashboard--logs--details has-loader">
<template v-if="activeTab === 'event deliveries'">
<LoaderComponent v-if="isloadingEventDeliveries || isloadingDeliveryAttempts" />
<h3>Details</h3>
<ul class="dashboard--logs--details--meta">
<li class="list-item-inline">
<div class="list-item-inline--label">IP Address</div>
<div class="list-item-inline--item color">{{ eventDeliveryAtempt?.ip_address || '-' }}</div>
</li>
<li class="list-item-inline">
<div class="list-item-inline--label">HTTP Status</div>
<div class="list-item-inline--item">{{ eventDeliveryAtempt?.http_status || '-' }}</div>
</li>
<li class="list-item-inline">
<div class="list-item-inline--label">API Version</div>
<div class="list-item-inline--item color">{{ eventDeliveryAtempt?.api_version || '-' }}</div>
</li>
<li class="list-item-inline">
<div class="list-item-inline--label">Endpoint</div>
<div class="list-item-inline--item color">
{{ eventDelsDetailsItem?.endpoint?.target_url }}
</div>
</li>
<li class="list-item-inline" v-if="eventDelsDetailsItem?.metadata.num_trials < eventDelsDetailsItem?.metadata.retry_limit && eventDelsDetailsItem?.status !== 'Success'">
<div class="list-item-inline--label">Next Retry</div>
<div class="list-item-inline--item color">{{ date(eventDelsDetailsItem?.metadata?.next_send_time) }} - {{ time(eventDelsDetailsItem.metadata?.next_send_time) }}</div>
</li>
<li class="list-item-inline">
<div class="list-item-inline--label">App Name</div>
<div class="list-item-inline--item color">
{{ eventDelsDetailsItem?.app_metadata?.title }}
</div>
</li>
<li class="list-item-inline" v-if="eventDelsDetailsItem?.status === 'Success'">
<div class="list-item-inline--label">Delivery Time</div>
<div class="list-item-inline--item color">{{ date(eventDelsDetailsItem?.updated_at) }} - {{ time(eventDelsDetailsItem?.updated_at) }}</div>
</li>
</ul>
<ul class="tabs tabs__logs">
<li v-for="(tab, index) in eventDetailsTabs" :key="'tabEventDels' + index" :class="eventDetailsActiveTab === tab.id ? 'active' : ''">


Step 2: 🧐 Snippet Analysis

From looking through the relevant snippets, I decided to make the following modifications:

File Path Proposed Changes
CONTRIBUTING.md Add a new section titled "Guidelines for Raising Issues". In this section, explain the importance of providing detailed descriptions when raising issues. Include a template for users to follow when creating new issues, prompting them to provide a clear and concise title, a detailed description of the issue, steps to reproduce the issue, expected and actual results, and any relevant error messages or logs.

Step 3: 📝 Planning

I have created a plan for writing the pull request. I am now working my plan and coding the required changes to address this issue. Here is the planned pull request:

Adding guidelines for raising issues
sweep/add-issue-guidelines

Description

This PR adds guidelines for raising issues to the CONTRIBUTING.md file. The new guidelines provide instructions on how to provide detailed descriptions when raising issues, improving the quality and clarity of the issues raised.

Changes Made

  • Added a new section titled "Guidelines for Raising Issues" to the CONTRIBUTING.md file.
  • Included instructions on providing a clear and concise title, a detailed description of the issue, steps to reproduce the issue, expected and actual results, and any relevant error messages or logs.
  • Added a template for users to follow when creating new issues.

Checklist

  • Updated the CONTRIBUTING.md file with the new guidelines.
  • Tested the changes locally to ensure they work as expected.
  • Verified that the new guidelines are clear and easy to follow.

Please review and merge this PR once the changes have been approved. Thank you!


Step 4: ⌨️ Coding

I have finished coding the issue. I am now reviewing it for completeness.


Step 5: 🔁 Code Review

Success! 🚀


I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
Join Our Discord

@sweep-ai sweep-ai bot linked a pull request Jul 26, 2023 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sweep Assigns Sweep to an issue or pull request.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant