Skip to content

Commit

Permalink
[Deangular] OSD without angular (#5086)
Browse files Browse the repository at this point in the history 
* Basic working version of OSD without angular (#4982)

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* [Data Explorer][Discover 2.0] Implement saved search embeddable (#5081)

* [Data Explorer][Discover 2.0] Implement saved search embeddable

Issue Resolve
#4233

---------

Signed-off-by: ananzh <ananzh@amazon.com>

* Deangular: removes angular paginate, cleanup data plugin and tilemap (#5060)

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* [Data Explorer] Delete legacy discover selenium tests (#5088)

* delete legacy discover functional tests

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* remove discover folder in config file

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

---------

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* [Data Explorer][Discover][Function Test] Fix ciGroup4 (#5099)

* add data-render-complete and data-shared-item for test convenience
* change docTableFieldCount to dataGridTableCellCount to fetch data grid cell
* add methods in data grid service to reuse current massive selenium tests
* update tests

Issue Resolve
#5098
#5058

Signed-off-by: Anan Zhuang <ananzh@amazon.com>

* [Data Explorer][Discover][Functional Test] fix ciGroup 8 (#5104)

Update index pattern fetch method in discover page due to changing to EuiComboBox.

Issue Resolve
#5103

Signed-off-by: Anan Zhuang <ananzh@amazon.com>

* Fix cigroup 1 with dataGridTable helper functions (#5105)

* fix1

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* fix 1

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* fix anchor test

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* fix cigroup1

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* address comments

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

---------

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* [Data Explorer] Fix functional cigroup 3 for save search on dashboard filtering (#5111)

* fix cigroup3

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* fix error

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

---------

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* add data-shared-item tag (#5119)

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* Modifying html tests to utilize jsx and fixing tests to include all pluginPaths (#5080)

Signed-off-by: Zashary Maskus-Lavin <zashary.maskus-lavin@oracle.com>

* fix cigroup6 (#5125)

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* [Discover] Search on load fix (#5112)

* fixes search on load

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* Fixes search after initial page load

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* [Data Explorer][Discover][Functional Test] Fix ciGroup7 (#5131)

* [Data Explorer][Discover][Functional Test] Fix ciGroup7

Issue Resolve
#5129

Signed-off-by: Anan Zhuang <ananzh@amazon.com>

* restore _discover_navigation

Signed-off-by: Anan Zhuang <ananzh@amazon.com>

---------

Signed-off-by: Anan Zhuang <ananzh@amazon.com>

* Deangular: removes angular from notify and utils of opendashboards legacy (#5085)

* Basic working version of OSD without angular (#4982)

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* deangularized notify and utils folders in the opendashboards legacy directory

Signed-off-by: Cameron Reed <chyltonreed@gmail.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: Cameron Reed <chyltonreed@gmail.com>
Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com>
Co-authored-by: Cameron Reed <chyltonreed@gmail.com>

* [Discover] Misc fixes (#5114)

* Canvas scrolling fix, remove notice and improve flyout focus

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* Hide action icons unless hovered or focussed on

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

* followup fixes from #5085

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

---------

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: ananzh <ananzh@amazon.com>
Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>
Signed-off-by: Anan Zhuang <ananzh@amazon.com>
Signed-off-by: Zashary Maskus-Lavin <zashary.maskus-lavin@oracle.com>
Signed-off-by: Cameron Reed <chyltonreed@gmail.com>
Co-authored-by: Anan Zhuang <ananzh@amazon.com>
Co-authored-by: Qingyang(Abby) Hu <abigailhu2000@gmail.com>
Co-authored-by: Zashary Maskus-Lavin <zashary.maskus-lavin@oracle.com>
Co-authored-by: Cameron Reed <cameron.reed@oracle.com>
Co-authored-by: Cameron Reed <chyltonreed@gmail.com>
  • Loading branch information
@ashwin-pc @ananzh
@abbyhu2000 @zashary @camreedOCI @creed127
6 people authored Sep 29, 2023
1 parent 6154e2d commit 0557ab1
Show file tree
Hide file tree
Showing 364 changed files with 864 additions and 28,892 deletions.
24 changes: 0 additions & 24 deletions DEVELOPER_GUIDE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -929,30 +929,6 @@ license.
The following developer guide rules are specific for working with the React framework.
#### Prefer reactDirective over react-component
When using `ngReact` to embed your react components inside Angular HTML, prefer the
`reactDirective` service over the `react-component` directive.
You can read more about these two ngReact methods [here](https://github.com/ngReact/ngReact#features).
Using `react-component` means adding a bunch of components into angular, while `reactDirective` keeps them isolated, and is also a more succinct syntax.
**Good:**
```html
<hello-component
fname="person.fname"
lname="person.lname"
watch-depth="reference"
></hello-component>
```
**Bad:**
```html
<react-component name="HelloComponent" props="person" watch-depth="reference" />
```
#### Name action functions and prop functions appropriately
Name action functions in the form of a strong verb and passed properties in the form of on<Subject><Change>. E.g:
Expand Down
12 changes: 1 addition & 11 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,6 @@
"JSONStream": "1.3.5",
"abortcontroller-polyfill": "^1.4.0",
"ajv": "^8.11.0",
"angular": "^1.8.2",
"angular-elastic": "^2.5.1",
"angular-sanitize": "^1.8.0",
"bluebird": "3.5.5",
"chalk": "^4.1.0",
"chokidar": "^3.4.2",
Expand Down Expand Up @@ -263,8 +260,6 @@
"@testing-library/jest-dom": "^5.16.2",
"@testing-library/react": "^12.1.2",
"@testing-library/react-hooks": "^7.0.2",
"@types/angular": "^1.8.4",
"@types/angular-mocks": "^1.7.1",
"@types/archiver": "^5.3.1",
"@types/babel__core": "^7.1.17",
"@types/bluebird": "^3.1.1",
Expand Down Expand Up @@ -345,10 +340,6 @@
"@types/zen-observable": "^0.8.0",
"@typescript-eslint/eslint-plugin": "^3.10.0",
"@typescript-eslint/parser": "^3.10.0",
"angular-aria": "^1.8.0",
"angular-mocks": "^1.8.2",
"angular-recursion": "^1.0.5",
"angular-route": "^1.8.0",
"archiver": "^5.3.0",
"axe-core": "^4.0.2",
"babel-eslint": "^10.0.3",
Expand Down Expand Up @@ -425,7 +416,6 @@
"ms-chromium-edge-driver": "^0.4.3",
"murmurhash3js": "3.0.1",
"mutation-observer": "^1.0.3",
"ngreact": "^0.5.1",
"nock": "12.0.3",
"node-stream-zip": "^1.15.0",
"normalize-path": "^3.0.0",
Expand Down Expand Up @@ -477,4 +467,4 @@
"node": ">=14.20.1 <19",
"yarn": "^1.22.10"
}
}
}
11 changes: 0 additions & 11 deletions packages/osd-i18n/GUIDELINE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,6 @@ The long term plan is to rely on using `FormattedMessage` and `i18n.translate()`
Currently, we support the following ReactJS `i18n` tools, but they will be removed in future releases:
- Usage of `props.intl.formatmessage()` (where `intl` is passed to `props` by `injectI18n` HOC).

#### In AngularJS

The long term plan is to rely on using `i18n.translate()` by statically importing `i18n` from the `@osd/i18n` package. **Avoid using the `i18n` filter and the `i18n` service injected in controllers, directives, services.**

- Call JS function `i18n.translate()` from the `@osd/i18n` package.
- Use `i18nId` directive in template.

Currently, we support the following AngluarJS `i18n` tools, but they will be removed in future releases:
- Usage of `i18n` service in controllers, directives, services by injecting it.
- Usage of `i18n` filter in template for attribute translation. Note: Use one-time binding ("{{:: ... }}") in filters wherever it's possible to prevent unnecessary expression re-evaluation.

#### In JavaScript

- Use `i18n.translate()` in NodeJS or any other framework agnostic code, where `i18n` is the I18n engine from `@osd/i18n` package.
Expand Down
101 changes: 4 additions & 97 deletions packages/osd-i18n/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# I18n

OpenSearch Dashboards relies on several UI frameworks (ReactJS and AngularJS) and
OpenSearch Dashboards relies on UI frameworks (ReactJS) and
requires localization in different environments (browser and NodeJS).
Internationalization engine is framework agnostic and consumable in
all parts of OpenSearch Dashboards (ReactJS, AngularJS and NodeJS). In order to simplify
all parts of OpenSearch Dashboards (ReactJS and NodeJS). In order to simplify
internationalization in UI frameworks, the additional abstractions are
built around the I18n engine: `react-intl` for React and custom
components for AngularJS. [React-intl](https://github.com/yahoo/react-intl)
built around the I18n engine: `react-intl` for React. [React-intl](https://github.com/yahoo/react-intl)
is built around [intl-messageformat](https://github.com/yahoo/intl-messageformat),
so both React and AngularJS frameworks use the same engine and the same
so the React framework uses the same engine and the same
message syntax.

## Localization files
Expand Down Expand Up @@ -343,98 +342,6 @@ export const MyComponent = injectI18n(
);
```

## AngularJS

The long term plan is to rely on using `i18n.translate()` by statically importing `i18n` from the `@osd/i18n` package. **Avoid using the `i18n` filter and the `i18n` service injected in controllers, directives, services.**

AngularJS wrapper has 4 entities: translation `provider`, `service`, `directive`
and `filter`. Both the directive and the filter use the translation `service`
with i18n engine under the hood.

The translation `provider` is used for `service` configuration and
has the following methods:
- `addMessages(messages: Map<string, string>, [locale: string])` - provides a way to register
translations with the library
- `setLocale(locale: string)` - tells the library which language to use by given
language key
- `getLocale()` - returns the current locale
- `setDefaultLocale(locale: string)` - tells the library which language to fallback
when missing translations
- `getDefaultLocale()` - returns the default locale
- `setFormats(formats: object)` - supplies a set of options to the underlying formatter
- `getFormats()` - returns current formats
- `getRegisteredLocales()` - returns array of locales having translations
- `init(messages: Map<string, string>)` - initializes the engine

The translation `service` provides only one method:
- `i18n(id: string, { values: object, defaultMessage: string, description: string })` –
translate message by id

The translation `filter` is used for attributes translation and has
the following syntax:
```
{{ ::'translationId' | i18n: { values: object, defaultMessage: string, description: string } }}
```

Where:
- `translationId` - translation id to be translated
- `values` - values to pass into translation
- `defaultMessage` - will be used unless translation was successful (the final
fallback in english, will be used for generating `en.json`)
- `description` - optional context comment that will be extracted by i18n tools
and added as a comment next to translation message at `defaultMessages.json`

The translation `directive` has the following syntax:
```html
<ANY
i18n-id="{string}"
i18n-default-message="{string}"
[i18n-values="{object}"]
[i18n-description="{string}"]
></ANY>
```

Where:
- `i18n-id` - translation id to be translated
- `i18n-default-message` - will be used unless translation was successful
- `i18n-values` - values to pass into translation
- `i18n-description` - optional context comment that will be extracted by i18n tools
and added as a comment next to translation message at `defaultMessages.json`

If HTML rendering in `i18n-values` is required then value key in `i18n-values` object
should have `html_` prefix. Otherwise the value will be inserted to the message without
HTML rendering.\
Example:
```html
<p
i18n-id="namespace.id"
i18n-default-message="Text with an emphasized {text}."
i18n-values="{
html_text: '<em>text</em>',
}"
></p>
```

Angular `I18n` module is placed into `autoload` module, so it will be
loaded automatically. After that we can use i18n directive in Angular templates:
```html
<span
i18n-id="welcome"
i18n-default-message="Hello!"
></span>
```

In order to translate attributes in AngularJS we should use `i18nFilter`:
```html
<input
type="text"
placeholder="{{ ::'osd.management.objects.searchAriaLabel' | i18n: {
defaultMessage: 'Search { title } Object',
values: { title }
} }}"
>
```

## I18n tools

In order to simplify localization process, some additional tools were implemented:
Expand Down
5 changes: 0 additions & 5 deletions packages/osd-i18n/angular/package.json
View file

This file was deleted.

69 changes: 0 additions & 69 deletions packages/osd-i18n/src/angular/__snapshots__/directive.test.ts.snap
View file

This file was deleted.

Loading

0 comments on commit 0557ab1

Please sign in to comment.